home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_2 / shuffl22.zip / SHUFFLE.DOC < prev    next >
Text File  |  1992-06-18  |  21KB  |  456 lines
  1.  
  2.                               WORD SHUFFLE
  3.  
  4.                                   v2.2
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.       
  14.                               
  15.                                 OVERVIEW
  16.                                 ________
  17.  
  18.  
  19.    Word Shuffle is a word game whereby the computer has scrambled the 
  20.    letters of a word and you must unscramble it to make points. The
  21.    game is pretty straight forward and the package also contains a 
  22.    program which add new puzzles to the database and as an event, will 
  23.    create new puzzles and start a new game, as soon as a pre-determined
  24.    number of players have solved all the puzzles. This is done 
  25.    automatically, all you must do is ensure that there are an adequate 
  26.    suppply of puzzles in the database. The same program used in the event
  27.    process is the same one you will use to add words to the database.
  28.  
  29.  
  30.  
  31.  
  32.    NOTE: Most errors will be logged to a file called DFRAME.ERR, which is
  33.          created in the directory you run the door from.
  34.  
  35.  
  36.                               INSTALLATION
  37.                               ____________
  38.  
  39.  
  40.    Installation is fairly easy and straight-forward. The following steps and
  41.    examples should have you up and running in a very short period of time.
  42.    It is assumed that you are familiar with setting up DOORS on your system.
  43.    To this end, only examples of the configuration file and Door batch file
  44.    are described.
  45.  
  46.       1) Create a directory to hold all WORD SHUFFLE files.
  47.  
  48.       2) Unzip SHUFFLxx.ZIP into the the above directory.
  49.  
  50.          NOTE: BRUN45.EXE is not included but is required !!!
  51.  
  52.       3) Create a configuration file, with a name of your choice, or
  53.          modify the supplied SHUFFLE.CFG file. A description follows:
  54.  
  55.             **                       Location of System File (See Below)
  56.             SUNRISE-80 BBS           Your BBS Name
  57.             Al                       Sysop's First Name
  58.             Lawrence                 Sysop's Last name
  59.      
  60. |-----------------------------------------------------------------------------|
  61. | READ!     1                        CommPort  \ These 2 lines are required   |
  62. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  63. |-----------------------------------------------------------------------------|
  64.  
  65.             00000000                 Registration Number
  66.       
  67.         #   1                        Number of plays per day/caller (1-3)
  68.                                      (Sysop gets 99 in registerd version ONLY!)
  69.  
  70.         #   2                        Keyboard Timeout Value in Minutes.
  71.  
  72.             50                       Number of entries in the Top Score file
  73.  
  74.         #   NONE                     Full drive:\path\filename for Top Score
  75.                                      Bulletin, or NONE
  76.  
  77.         #   NONE                     Full drive:\path\filename for Top Score
  78.                                      Bulletin (Color), or NONE
  79.  
  80.         #   20                       Number of puzzles comprising the game(QUE)
  81.  
  82.             2                        1 = Do Not Display ADOPT-A-DOOR Message
  83.                                      2 = Display ADOPT-A-DOOR Message
  84.  
  85.             3                        The number of players that must complete
  86.                                      all puzzles, before the puzzles are 
  87.                                      changed automatically by SHUFWORD, in 
  88.                                      your nightly event processing.
  89.  
  90.     !   #   0                        Time Remaining in Door
  91.                                      (Sysop = Time Remaining - REG. VERSION)
  92.  
  93.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  94.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  95.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  96.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  97.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  98.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  99.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  100.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  101.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  102.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  103.  
  104.     @   #   XXXX/YYYY                 Blackout Range  From/To
  105.     @   #   XXXX/YYYY                 Blackout Range  From/To
  106.     @   #   XXXX/YYYY                 Blackout Range  From/To
  107.     @   #   XXXX/YYYY                 Blackout Range  From/To
  108.     @   #   XXXX/YYYY                 Blackout Range  From/To
  109.  
  110.          ** = Replace with ONE of the following:
  111.  
  112. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  113. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  114. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  115.                                    (Note:DOOR.SYS must be in SAME directory)
  116. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  117. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  118. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  119. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  120. C:\BBS\GTUSER.BBS               <- For GT Power 
  121.                                    * if using this option you must put the
  122.                                      ComPort # on line 5 and the Node # on
  123.                                      line 6 of the configuration file
  124.  
  125.  
  126.  
  127.          # =  Requires registration to change to a different value
  128.          ! = See "Plays Per DAY/DOOR Time" Below
  129.          @ = See "Blackout Periods" Below
  130.  
  131.  
  132.               NOTE:THERE ARE TO BE NO BLANK LINES IN THIS FILE !
  133.  
  134.       4) When running more than one node, be sure to read Multi-Node
  135.          described below.
  136.  
  137.  
  138.  
  139.                           BLACKOUT PERIODS
  140.                           ________________
  141.  
  142.       Use the Blackout ranges option to define up to 5 time periods during
  143.       which you DO NOT want the Door to be played. If a caller tries to access 
  144.       the Door during the Blackout period, they will be shown a message that
  145.       contains ALL the Blackout periods you have defined, and to try the Door
  146.       at a later time.
  147.  
  148.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  149.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  150.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  151.  
  152.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  153.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  154.                    a Blackout range.
  155.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  156.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  157.  
  158.  
  159.                           PLAYS Per DAY/DOOR Time
  160.                           _______________________
  161.  
  162.       Plays Per Day and Door Time can be controlled several ways:
  163.  
  164.       (1) You can use the Games Per Day, singular option, in the config
  165.           file above. This option, will affect ALL callers whose Security
  166.           Level is NOT defined in any of the 10 optional Security Level/
  167.           Plays Per Day entries in the config file.
  168.  
  169.       (2) You can use the Door Time, singular option, in the config file
  170.           above. This option, will affect ALL callers whose Security
  171.           Level is NOT defined in any of the 10 optional Security Level/
  172.           Plays Per Day/Door Time entries in the config file.
  173.  
  174.       (3) You can restrict the number of games a specific Security Level
  175.           will be allowed to play per day or REWARD specific Levels with 
  176.           more Plays Per Day. 
  177.  
  178.           Likewise, you can restrict the Play time for a specific Security
  179.           Level or REWARD specific Levels with more Door Time.
  180.  
  181.           These options are handled by the use of the 10 config 
  182.           entries (000=00/00). 
  183.           
  184.           The format of each entry is as follows:
  185.  
  186.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  187.                      where =  is a constant and MUST be included
  188.                      where YY is the # of games per day (must be 2 digits)
  189.                      where / is a constant and MUST be included
  190.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  191.           
  192.           If the callers Security Level is NOT defined, his/her Plays Per
  193.           Day and Door Time will be controlled by the values in items
  194.           (1) and (2), above, respectively..
  195.  
  196.           You may define up to 10 Security Levels. All unused entries must
  197.           be defined as   000=00/00
  198.         --------------------------------------------------------------------
  199.           Example: Suppose you had 3 Security Levels defined on your BBS as
  200.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  201.           wanted to set Plays Per Day as :     Subscriber=5
  202.                                            Visiting Sysop=2
  203.                                                   CoSysop=3
  204.                                                    Friend=10 
  205.           
  206.           and Door Time as follows:     Subscriber=30 minutes
  207.                                     Visiting Sysop=20 minutes
  208.                                            CoSysop=10 minutes 
  209.                                             Friend=remaining call time
  210.                                
  211.  
  212.           You would set the Individual "Games per Day" config entry to 1 and 
  213.           the individual "Door Time" to 5 minutes (these would be the 
  214.           default number of games and default Time for all Security Levels
  215.           other than 20,30 or 40... make them any number you want). Next you
  216.           would replace 4 of the Security Level entries as :  020=05/30                                               
  217.                                                               030=02/20
  218.                                                               040=03/10
  219.                                                               090=10/0
  220.  
  221.  
  222.  
  223.  
  224.                         NON-STANDARD COM SUPPORT
  225.                         ________________________
  226.  
  227.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  228.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  229.       number after the configuration filename. Let's assume your Door is
  230.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  231.       passed to your Door would be:
  232.  
  233.                             FOOBAR FOOBAR.CFG /5
  234.  
  235.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  236.       normally used with COM1. No /x parameter is needed for the standard
  237.       IRQ's.
  238.  
  239.       As an alternative, you may use an environmental variable on the command
  240.       line. To use the variable (following the example above), place a 
  241.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  242.       different IRQ number for each node). The command line would now look 
  243.       like this: 
  244.  
  245.                           FOOBAR FOOBAR.CFG /%IRQ%
  246.       
  247.       This, in combination with the use of the environmental variables 
  248.       described in the MULTI-NODE SETUP section will allow you to use one 
  249.       batch file and one config file to run this door on all nodes.
  250.  
  251.  
  252.  
  253.  
  254.                            MULTI-NODE SETUP
  255.                            ________________
  256.  
  257.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  258.       ability to access a configuration file which will have its own system 
  259.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  260.       line. There are 2 ways to accomplish this:
  261.  
  262.       (1) Create a separate configuration file for each node. The only 
  263.           difference between each file would be the location of the system 
  264.           file for that particular node. For example, on my system there are 2
  265.           nodes and the first line of the config files would look like this:
  266.  
  267.                         NODE1:  H:\PCB1\DOOR.SYS
  268.                         NODE2:  H:\PCB2\DOOR.SYS
  269.  
  270.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  271.  
  272.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  273.           the following PCBoard environmental variables:
  274.  
  275.                  PCBDIR    (Directory containing the System file)
  276.                  PCBDRIVE  (Drive containing the System file)
  277.  
  278.           Thus, the first line of the SINGLE configuration file, for this Door
  279.           would look like this:
  280.  
  281.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  282.  
  283.       NOTE: This option, as described, assumes that you are running PCBoard 
  284.             14.5a software. The environmental variables are automatically 
  285.             created by the software for each node.
  286.  
  287.             HOWEVER, if you are running other BBS software you should be able
  288.             to set the variables EXACTLY as described below, for EACH node 
  289.             (more than likely in each batch file you use to bring up EACH node):
  290.  
  291.                             PCBDRIVE=C:
  292.                             ^^^^^^^^^
  293.                             PCBDIR=\NODE2
  294.                             ^^^^^^^^
  295.             
  296.             Info with a carat (^) under it, MUST be typed as is. The rest 
  297.             depends on your naming conventions. 
  298.  
  299.             This, in combination with the use of the optional environmental
  300.             variable described in the NON-STANDARD COM SUPPORT section, will
  301.             allow you to use one batch file and one config file to run this 
  302.             door on all nodes.
  303.  
  304.  
  305.  
  306.  
  307.                                 SHUFWORD
  308.                                 ---------
  309.  
  310.     This is the Word Shuffle utility maintenance progam. This program is
  311.     used to add words to the Shuffle database and to perform the nightly 
  312.     maintenance.
  313.  
  314.     Note: If running an unregistered copy you will be restricted to 60
  315.           words in the Shuffle database vs 1000 words in the registered
  316.           copy and you will not be able to run as a nightly event.
  317.  
  318.      ********************************************************************
  319.      *                                                                  *
  320.      *   Assuming that your config file is named SHUFFLE.CFG, use the   *
  321.      *   following EXAMPLE to run SHUFWORD to add words to the         *
  322.      *   SHUFFLE database.                     ^^^^^^^^^                *
  323.      *                                                                  *
  324.      *                  cd\pcb\doors\shuffle                            *           
  325.      *                  SHUFWORD SHUFFLE.CFG                           *
  326.      *                                                                  *
  327.      ********************************************************************                                                                
  328.  
  329.  
  330.                              EVENT PROCESSING
  331.                              ________________
  332.  
  333.     After your callers complete all the words you have defined, it becomes
  334.     necessary to change them and start a new game. This task can be done 
  335.     manually, using SHUFWORD or automatically, as part of your nightly 
  336.     EVENT process.
  337.  
  338.     As a nightly EVENT, SHUFWORD checks to see if the number of players, 
  339.     as defined in the configuration file, have completed all words, in which
  340.     case it will automatically supply a new set of words and reset/update 
  341.     the appropriate files. The following is an EXAMPLE of what needs to be 
  342.     placed in your EVENT.SYS file (PcBoard):
  343.  
  344.  
  345.            CD\PCB\DOORS\SHUFFLE        Location of SHUFFLE files
  346.            SHUFWORD SHUFFLE.CFG /E     EXE filename and config filename
  347.            CD\PCB
  348.            BOARD
  349.  
  350.  
  351.  
  352.              
  353.  
  354.  
  355.  
  356.  
  357.                                ADOPT-A-DOOR
  358.                                ____________
  359.  
  360.  
  361.     Having been a Sysop for a number of years, I have had my share of problems
  362.     and frustrations getting financial support for my board's upkeep. A fellow
  363.     Sysop left a message on my board, not long ago, about a concept that was
  364.     being used by several boards around the country.
  365.  
  366.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  367.     would be the same as sending in a donation, only this way it is earmarked
  368.     for registering a particular door. In a way, the user feels he/she is
  369.     "getting something in return". As a Door author I have decided to build
  370.     this concept into each of my Door programs. The concept replaces the
  371.     usual message "tell the Sysop to register this Door" we find in most
  372.     doors.
  373.  
  374.     If the Door is unregisterd then a message appears on the opening screen
  375.     to that effect. After finishing or suspending a game, a message screen
  376.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  377.     caller to contact the Sysop to find out if there is any further details
  378.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  379.     time, etc to callers that ADOPT-A-DOOR.
  380.  
  381.     If the Door has been registered, either by the Sysop or other callers,
  382.     the names of those contributors will be displayed in the closing screen.
  383.  
  384.     NOTE: If you want to display the names of the callers that contributed
  385.           to registering the Door, you must create an ASCII file called
  386.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  387.           the name(s) of the contributors (one on each line, maximum of 5
  388.           entries, each a maximum of 30 characters long). This file must be
  389.           saved, in ASCII format, and placed in the Door directory.
  390.  
  391.  
  392.  
  393.                               LEGALITIES
  394.                               __________
  395.  
  396.  
  397.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  398.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  399.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  400.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  401.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  402.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  403.       OR BREACH OF ANY WARRANTY.
  404.  
  405.  
  406.  
  407.  
  408.  
  409.                              DISTRIBUTION
  410.                              ____________
  411.  
  412.    You may make this file available for downloading from your BBS or you may
  413.    upload it to any BBS of your choice, provided that you do not make any
  414.    changes to the contents of the archive (ZIP file). The archive and its
  415.    individual contents may not be used by any service that charges any money
  416.    whatsoever, without the written permission of the author.
  417.  
  418.  
  419.  
  420.  
  421.  
  422.                              REGISTRATION
  423.                              ____________
  424.  
  425.    Registration and the subsequent insertion of the registration number into
  426.    your configuation file, allows for the display of your BBS name on the
  427.    opening and closing screen as well as the reduction of a delay built into
  428.    the opening screen display along with the ability to change certain values
  429.    in the configuration file.
  430.  
  431.    To register your copy of WORD SHUFFLE, please fill out the registration
  432.    form (REGISTER.FRM) and mail it along with a small donation ($20,25,etc) to
  433.    the name and address on the form or supply a self-addressed stamped 
  434.    envelope for registration number by return mail.t
  435.  
  436.    Be sure to use the proper upper/lower case when filling in your name and
  437.    BBS name, as they MUST match the way you entered them in the configuration
  438.    file.             ^^^^
  439.  
  440.    Based upon information supplied on the registration form, I will pre-
  441.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  442.    up your registration number.
  443.  
  444.  
  445.  
  446.                                  MISC
  447.                                  ____
  448.  
  449.    The latest version of WORD SHUFFLLE and other fine SUNRISE DOOR programs
  450.    are always available for download from SUNRISE-80 BBS.
  451.  
  452.    Remember, should you have any problems, questions or suggestions, be sure
  453.    to drop me a message on either of the aforementioned BBS'.  I am now a 
  454.    PCRelay node (SUNRISE) and can be reached thru the SYSOP, BBSDOORS, 
  455.    PCBhints RIME conferences.
  456.